/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.server.config;

import java.io.Serializable;
import java.util.Collections;
import java.util.Map;

/**
 * 設定内容を保持するクラス。<br>
 * (Immutableオブジェクト)<br>
 */
public class MidoriConfig implements Serializable {
	//==========================================================
	//定数

	/**
	 * シリアルバージョンID
	 * (少しでも処理が軽くなるようにするために定義しておく)
	 */
	private static final long serialVersionUID = 1L;


	//==========================================================
	//フィールド

	/**
	 * ルートパッケージ
	 */
	public final String rootPackage;

	/**
	 * コンテナ
	 */
	public final String container;

	/**
	 * プラグインのMap
	 */
	public final Map<String, String> pluginMap;


	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//コンストラクタ

	/**
	 * コンストラクタです。<br>
	 * プラグインのMapは外部から変更できないようにするため、<code>Collections.unmodifiableMap()</code>を使って不変のMapにラッピングします。<br>
	 *
	 * @param rootPackage ルートパッケージ
	 * @param container コンテナ
	 * @param pluginMap プラグインのMap
	 */
	public MidoriConfig(String rootPackage, String container,
			Map<String, String> pluginMap) {
		//==========================================================
		//引数の値をフィールドに設定

		//ルートパッケージ
		this.rootPackage = rootPackage;

		//コンテナ
		this.container = container;

		//プラグインのMap
		//(外部から変更できないようにするため、Collections.unmodifiableMap()を使って不変のMapにラッピングする)
		this.pluginMap = Collections.unmodifiableMap(pluginMap);
	}


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//オーバーライドするメソッド

	/**
	 * オブジェクトの文字列表現を返します。<br>
	 *
	 * @return オブジェクトの文字列表現
	 */
	@Override
	public String toString() {
		//各フィールドの内容を1つの文字列に結合して返す
		return "rootPackage=" + this.rootPackage + ", container="
				+ this.container + ", pluginMap=" + this.pluginMap;
	}

}
